/* 
 * Copyright (c) 2012, Fromentin Xavier, Schnell Michaël, Dervin Cyrielle, Brabant Quentin
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *      * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *      * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *      * The names of its contributors may not be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL Fromentin Xavier, Schnell Michaël, Dervin Cyrielle OR Brabant Quentin 
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package kameleon.gui.exception;

import kameleon.exception.KameleonException;
import kameleon.gui.language.GuiLanguage;
import kameleon.gui.language.SwitchLanguage;

/**
 * Exception thrown by {@code SwitchLanguage} when an unknown 
 * language file is requested.
 * 
 * @author 		Schnell Michaël
 * @version		1.0
 * 
 * @see			SwitchLanguage
 */
public class InvalidLanguageException extends KameleonException {

	/**
	 * Needed to serialize this class.
	 * 
	 * @see		java.io.Serializable
	 */
	private static final long serialVersionUID = -6954614452084699865L ;

	/**
	 * Default error message.
	 */
	private static final String DEFAULT_ERROR_MESSAGE 
	= "An unknown language file was requested." ;//$NON-NLS-1$

	/**
	 * Formatted error message.
	 */
	private static final String FORMATTED_ERROR_MESSAGE 
	= "The language file for the language '%s' could not be found." ;//$NON-NLS-1$

	/**
	 * Builds a {@code InvalidLanguageException} with a default 
	 * error message.
	 */
	public InvalidLanguageException() {
		this(DEFAULT_ERROR_MESSAGE) ;
	}// InvalidLanguageException()

	/**
	 * Builds a {@code InvalidLanguageException} with a formatted 
	 * error message.
	 * 
	 * @param	lang
	 * 			language for which the unknown file was encountered
	 * 
	 * @param	cause
	 * 			cause of this exception
	 */
	public InvalidLanguageException(GuiLanguage lang, Throwable cause) {
		super(String.format(FORMATTED_ERROR_MESSAGE, 
				lang.getLanguage().getDisplayLanguage()), cause) ;
	}// InvalidLanguageException(GuiLanguage, Throwable)

	/**
	 * Builds a {@code InvalidLanguageException} with a formatted 
	 * error message.
	 * 
	 * @param	lang
	 * 			language for which the unknown file was encountered
	 */
	public InvalidLanguageException(GuiLanguage lang) {
		this(String.format(FORMATTED_ERROR_MESSAGE, 
				lang.getLanguage().getDisplayLanguage())) ;
	}// InvalidLanguageException(GuiLanguage)

	/**
	 * Builds a {@code InvalidLanguageException} with the given message.
	 * 
	 * @param 	message
	 * 			detailed message for the exception
	 */
	public InvalidLanguageException(String message) {
		super(message) ;
	}// InvalidLanguageException(String)

}// class InvalidLanguageException